<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PxConvexMeshDesc Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="PhysXLogoBlack.png"/></td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classPxConvexMeshDesc.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="classPxConvexMeshDesc-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">PxConvexMeshDesc Class Reference<div class="ingroups"><a class="el" href="group__cooking.html">Cooking</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Descriptor class for <a class="el" href="classPxConvexMesh.html" title="A convex mesh. ">PxConvexMesh</a>.  
 <a href="classPxConvexMeshDesc.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="PxConvexMeshDesc_8h_source.html">PxConvexMeshDesc.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for PxConvexMeshDesc:</div>
<div class="dyncontent">
<div class="center"><img src="classPxConvexMeshDesc__coll__graph.png" border="0" usemap="#PxConvexMeshDesc_coll__map" alt="Collaboration graph"/></div>
<map name="PxConvexMeshDesc_coll__map" id="PxConvexMeshDesc_coll__map">
<area shape="rect" id="node2" href="structPxBoundedData.html" title="PxBoundedData" alt="" coords="5,89,121,115"/>
<area shape="rect" id="node3" href="structPxStridedData.html" title="PxStridedData" alt="" coords="10,5,117,32"/>
<area shape="rect" id="node4" href="classPxFlags.html" title="PxFlags\&lt; PxConvexFlag\l::Enum, PxU16 \&gt;" alt="" coords="146,81,311,123"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ga2b98217f34d8856ebe839821740ac438"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__cooking.html#ga2b98217f34d8856ebe839821740ac438">PxConvexMeshDesc</a> ()</td></tr>
<tr class="memdesc:ga2b98217f34d8856ebe839821740ac438"><td class="mdescLeft">&#160;</td><td class="mdescRight">constructor sets to default.  <a href="group__cooking.html#ga2b98217f34d8856ebe839821740ac438">More...</a><br /></td></tr>
<tr class="separator:ga2b98217f34d8856ebe839821740ac438"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6e86954b2426aae207489af9928d45e3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__cooking.html#ga6e86954b2426aae207489af9928d45e3">setToDefault</a> ()</td></tr>
<tr class="memdesc:ga6e86954b2426aae207489af9928d45e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">(re)sets the structure to the default.  <a href="group__cooking.html#ga6e86954b2426aae207489af9928d45e3">More...</a><br /></td></tr>
<tr class="separator:ga6e86954b2426aae207489af9928d45e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6155ac1dfe72113670b79dbf363b21d2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__cooking.html#ga6155ac1dfe72113670b79dbf363b21d2">isValid</a> () const</td></tr>
<tr class="memdesc:ga6155ac1dfe72113670b79dbf363b21d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the descriptor is valid.  <a href="group__cooking.html#ga6155ac1dfe72113670b79dbf363b21d2">More...</a><br /></td></tr>
<tr class="separator:ga6155ac1dfe72113670b79dbf363b21d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a939b97ee9f36cd1c1a7b7c34b0e764ef"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structPxBoundedData.html">PxBoundedData</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxConvexMeshDesc.html#a939b97ee9f36cd1c1a7b7c34b0e764ef">points</a></td></tr>
<tr class="memdesc:a939b97ee9f36cd1c1a7b7c34b0e764ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Vertex positions data in <a class="el" href="structPxBoundedData.html">PxBoundedData</a> format.  <a href="#a939b97ee9f36cd1c1a7b7c34b0e764ef">More...</a><br /></td></tr>
<tr class="separator:a939b97ee9f36cd1c1a7b7c34b0e764ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1b710dc3c2ef759a6bef8bd888e1ecf8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structPxBoundedData.html">PxBoundedData</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxConvexMeshDesc.html#a1b710dc3c2ef759a6bef8bd888e1ecf8">polygons</a></td></tr>
<tr class="memdesc:a1b710dc3c2ef759a6bef8bd888e1ecf8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Polygons data in <a class="el" href="structPxBoundedData.html">PxBoundedData</a> format.  <a href="#a1b710dc3c2ef759a6bef8bd888e1ecf8">More...</a><br /></td></tr>
<tr class="separator:a1b710dc3c2ef759a6bef8bd888e1ecf8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4e760fc52d1f0f9e55c919320bed1cef"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structPxBoundedData.html">PxBoundedData</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxConvexMeshDesc.html#a4e760fc52d1f0f9e55c919320bed1cef">indices</a></td></tr>
<tr class="memdesc:a4e760fc52d1f0f9e55c919320bed1cef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Polygon indices data in <a class="el" href="structPxBoundedData.html">PxBoundedData</a> format.  <a href="#a4e760fc52d1f0f9e55c919320bed1cef">More...</a><br /></td></tr>
<tr class="separator:a4e760fc52d1f0f9e55c919320bed1cef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6d2315944dad51ba136b3563b7c00ab"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__cooking.html#ga36d3375ae49e62c3842c3fbe0c620651">PxConvexFlags</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxConvexMeshDesc.html#af6d2315944dad51ba136b3563b7c00ab">flags</a></td></tr>
<tr class="memdesc:af6d2315944dad51ba136b3563b7c00ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flags bits, combined from values of the enum <a class="el" href="structPxConvexFlag.html" title="Flags which describe the format and behavior of a convex mesh. ">PxConvexFlag</a>.  <a href="#af6d2315944dad51ba136b3563b7c00ab">More...</a><br /></td></tr>
<tr class="separator:af6d2315944dad51ba136b3563b7c00ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a467c6feb39620d546a6bc9054405a728"><td class="memItemLeft" align="right" valign="top">PxU16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxConvexMeshDesc.html#a467c6feb39620d546a6bc9054405a728">vertexLimit</a></td></tr>
<tr class="memdesc:a467c6feb39620d546a6bc9054405a728"><td class="mdescLeft">&#160;</td><td class="mdescRight">Limits the number of vertices of the result convex mesh. Hard maximum limit is 256 and minimum limit is 4 if <a class="el" href="structPxConvexFlag.html#a4b7bd21fa96c72b320a39e880208b4b6a62cbe73f95f10cb93b5d471affef7c89" title="Enables plane shifting vertex limit algorithm. ">PxConvexFlag::ePLANE_SHIFTING</a> is used, otherwise the minimum limit is 8.  <a href="#a467c6feb39620d546a6bc9054405a728">More...</a><br /></td></tr>
<tr class="separator:a467c6feb39620d546a6bc9054405a728"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8dc525326a4835f94311f4e44ca219f2"><td class="memItemLeft" align="right" valign="top">PxU16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxConvexMeshDesc.html#a8dc525326a4835f94311f4e44ca219f2">quantizedCount</a></td></tr>
<tr class="memdesc:a8dc525326a4835f94311f4e44ca219f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum number of vertices after quantization. The quantization is done during the vertex cleaning phase. The quantization is applied when <a class="el" href="structPxConvexFlag.html#a4b7bd21fa96c72b320a39e880208b4b6ae10437ca01f341cb3afff0bd2c40529d" title="Quantizes the input vertices using the k-means clustering. ">PxConvexFlag::eQUANTIZE_INPUT</a> is specified.  <a href="#a8dc525326a4835f94311f4e44ca219f2">More...</a><br /></td></tr>
<tr class="separator:a8dc525326a4835f94311f4e44ca219f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Descriptor class for <a class="el" href="classPxConvexMesh.html" title="A convex mesh. ">PxConvexMesh</a>. </p>
<dl class="section note"><dt>Note</dt><dd>The number of vertices and the number of convex polygons in a cooked convex mesh is limited to 256.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxConvexMesh.html" title="A convex mesh. ">PxConvexMesh</a> <a class="el" href="classPxConvexMeshGeometry.html" title="Convex mesh geometry class. ">PxConvexMeshGeometry</a> <a class="el" href="classPxShape.html" title="Abstract class for collision shapes. ">PxShape</a> <a class="el" href="classPxPhysics.html#a54fc5f8b0884977ccfd45ea829392a52" title="Creates a convex mesh object. ">PxPhysics.createConvexMesh()</a> </dd></dl>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="af6d2315944dad51ba136b3563b7c00ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af6d2315944dad51ba136b3563b7c00ab">&#9670;&nbsp;</a></span>flags</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__cooking.html#ga36d3375ae49e62c3842c3fbe0c620651">PxConvexFlags</a> PxConvexMeshDesc::flags</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Flags bits, combined from values of the enum <a class="el" href="structPxConvexFlag.html" title="Flags which describe the format and behavior of a convex mesh. ">PxConvexFlag</a>. </p>
<p><b>Default:</b> 0 </p>

<p class="reference">Referenced by <a class="el" href="group__cooking.html#ga6155ac1dfe72113670b79dbf363b21d2">isValid()</a>.</p>

</div>
</div>
<a id="a4e760fc52d1f0f9e55c919320bed1cef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e760fc52d1f0f9e55c919320bed1cef">&#9670;&nbsp;</a></span>indices</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structPxBoundedData.html">PxBoundedData</a> PxConvexMeshDesc::indices</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Polygon indices data in <a class="el" href="structPxBoundedData.html">PxBoundedData</a> format. </p>
<p>Pointer to first index.</p>
<p><b>Default:</b> NULL</p>
<p>This is declared as a void pointer because it is actually either an PxU16 or a PxU32 pointer.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structPxHullPolygon.html" title="Polygon data. ">PxHullPolygon</a> <a class="el" href="structPxConvexFlag.html#a4b7bd21fa96c72b320a39e880208b4b6a18b6c42727636f294561c735de5dc37b">PxConvexFlag::e16_BIT_INDICES</a> </dd></dl>

<p class="reference">Referenced by <a class="el" href="group__cooking.html#ga6155ac1dfe72113670b79dbf363b21d2">isValid()</a>.</p>

</div>
</div>
<a id="a939b97ee9f36cd1c1a7b7c34b0e764ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a939b97ee9f36cd1c1a7b7c34b0e764ef">&#9670;&nbsp;</a></span>points</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structPxBoundedData.html">PxBoundedData</a> PxConvexMeshDesc::points</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Vertex positions data in <a class="el" href="structPxBoundedData.html">PxBoundedData</a> format. </p>
<p><b>Default:</b> NULL </p>

<p class="reference">Referenced by <a class="el" href="group__cooking.html#ga6155ac1dfe72113670b79dbf363b21d2">isValid()</a>.</p>

</div>
</div>
<a id="a1b710dc3c2ef759a6bef8bd888e1ecf8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1b710dc3c2ef759a6bef8bd888e1ecf8">&#9670;&nbsp;</a></span>polygons</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structPxBoundedData.html">PxBoundedData</a> PxConvexMeshDesc::polygons</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Polygons data in <a class="el" href="structPxBoundedData.html">PxBoundedData</a> format. </p>
<p>Pointer to first polygon. </p>
<p><b>Default:</b> NULL</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structPxHullPolygon.html" title="Polygon data. ">PxHullPolygon</a> </dd></dl>

<p class="reference">Referenced by <a class="el" href="group__cooking.html#ga6155ac1dfe72113670b79dbf363b21d2">isValid()</a>.</p>

</div>
</div>
<a id="a8dc525326a4835f94311f4e44ca219f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8dc525326a4835f94311f4e44ca219f2">&#9670;&nbsp;</a></span>quantizedCount</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PxU16 PxConvexMeshDesc::quantizedCount</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Maximum number of vertices after quantization. The quantization is done during the vertex cleaning phase. The quantization is applied when <a class="el" href="structPxConvexFlag.html#a4b7bd21fa96c72b320a39e880208b4b6ae10437ca01f341cb3afff0bd2c40529d" title="Quantizes the input vertices using the k-means clustering. ">PxConvexFlag::eQUANTIZE_INPUT</a> is specified. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structPxConvexFlag.html#a4b7bd21fa96c72b320a39e880208b4b6ae10437ca01f341cb3afff0bd2c40529d" title="Quantizes the input vertices using the k-means clustering. ">PxConvexFlag::eQUANTIZE_INPUT</a></dd></dl>
<p><b>Range:</b> [4, 65535]<br />
 <b>Default:</b> 255 </p>

<p class="reference">Referenced by <a class="el" href="group__cooking.html#ga6155ac1dfe72113670b79dbf363b21d2">isValid()</a>.</p>

</div>
</div>
<a id="a467c6feb39620d546a6bc9054405a728"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a467c6feb39620d546a6bc9054405a728">&#9670;&nbsp;</a></span>vertexLimit</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PxU16 PxConvexMeshDesc::vertexLimit</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Limits the number of vertices of the result convex mesh. Hard maximum limit is 256 and minimum limit is 4 if <a class="el" href="structPxConvexFlag.html#a4b7bd21fa96c72b320a39e880208b4b6a62cbe73f95f10cb93b5d471affef7c89" title="Enables plane shifting vertex limit algorithm. ">PxConvexFlag::ePLANE_SHIFTING</a> is used, otherwise the minimum limit is 8. </p>
<dl class="section note"><dt>Note</dt><dd>Vertex limit is only used when <a class="el" href="structPxConvexFlag.html#a4b7bd21fa96c72b320a39e880208b4b6ad3153afeb45ae6488b40fc4698919c6b">PxConvexFlag::eCOMPUTE_CONVEX</a> is specified. </dd>
<dd>
The please see <a class="el" href="structPxConvexFlag.html#a4b7bd21fa96c72b320a39e880208b4b6a62cbe73f95f10cb93b5d471affef7c89" title="Enables plane shifting vertex limit algorithm. ">PxConvexFlag::ePLANE_SHIFTING</a> for algorithm explanation</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structPxConvexFlag.html#a4b7bd21fa96c72b320a39e880208b4b6a62cbe73f95f10cb93b5d471affef7c89" title="Enables plane shifting vertex limit algorithm. ">PxConvexFlag::ePLANE_SHIFTING</a></dd></dl>
<p><b>Range:</b> [4, 255]<br />
 <b>Default:</b> 255 </p>

<p class="reference">Referenced by <a class="el" href="group__cooking.html#ga6155ac1dfe72113670b79dbf363b21d2">isValid()</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxConvexMeshDesc_8h_source.html">PxConvexMeshDesc.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="classPxConvexMeshDesc.html">PxConvexMeshDesc</a></li>
    <li class="footer">Copyright &copy; 2008-2021 NVIDIA Corporation, 2788 San Tomas Expressway, Santa Clara, CA 95051 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a></li>
  </ul>
</div>
</body>
</html>
